tag-service API

tag-service supports 8 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/tag/config POST version		Input:	Output:
	Description: Tag uploads its configuration dump to the RTLS Controller if it has been requested with 'sendconfig'. This is an alias to the original command that T201 tags call: /edm/device/config. Example 1: Tag with mac 00:00:00:00:04:D2 uploads configuration with values X=1 and Y=2 /epe/tag/config?id=00:00:00:00:04:D2&X=1&Y=2 Role Required: Call Counter: Total: 0, Failed: 0	id (required) - [String] mac of the tag key (optional) - [String] key - value pairs defining the configuration
/epe/tag/confirm POST version		Input:	Output:
	Description: Tag reports the result of command execution. If execution of all commands succeeded, code is zero. If execution failed, code is nonzero and optional cmd specifies the command that failed and optional msg specifies the error message. In both cases, when the tag calls /tag/hello again, it will get zero commands (unless new commands have been added int the mailbox). This is an alias to the original command that T201 tags call: /edm/device/confirm. Example 1: Tag 11:22:33:44:55:66 reports a successful result /epe/tag/confirm?id=00:00:00:00:04:D2&code=0 Example 2: Tag 11:22:33:44:55:66 reports a failure: command gosleep was unknown /epe/tag/confirm?id=00:00:00:00:04:D2&code=55&cmd=gosleep&msg=command unknown Role Required: Call Counter: Total: 0, Failed: 0	id (required) - [String] mac of the tag code (required) - [int] status code: 0=success, error otherwise cmd (optional) - [String] command whose execution failed msg (optional) - [String] error message
/epe/tag/download POST version		Input:	Output:
	Description: Tag downloads a firmware file. Role Required: Call Counter: Total: 0, Failed: 0	fileid (required) - [long] file id
/epe/tag/hello POST version		Input:	Output:
	Description: Tag reminds of it's existence. Tag will receive new commands if there are any pending in mailboxes. Tag may also report its ip and apmac values. This is an alias to the original command that T201 tags call: /edm/device/hello. Example 1: Tag 00:00:00:00:04:D2 just requests new commands /epe/tag/hello?id=00:00:00:00:04:D2 Example 2: Tag 00:00:00:00:04:D2 requests new commands, and provides ip, apmac /epe/tag/hello?id=00:00:00:00:04:D2&ip=10.0.0.10&apmac=10.0.0.10 Role Required: Call Counter: Total: 0, Failed: 0	id (required) - [String] mac of the tag ip (optional) - [String] IP address apmac (optional) - [String] mac of the access point battery (optional) - [int] the tag's battery level (0-100)
/epe/tag/info POST version		Input:	Output:
	Description: Tag introduces itself to Ekahau RTLS Controller. A new record is created in the tag database. Tag may also call this command afterwards to update its info. This is an alias to the original command that T201 tags call: /edm/device/info. Example 1: Tag 00:00:00:00:04:D2 sends a simple info message /epe/tag/info?id=00:00:00:00:04:D2&type=T201 Example 2: Tag 00:00:00:00:04:D2 sends a full info message /epe/tag/info?id=00:00:00:00:04:D2&type=T201&name=test&serialnumber=1234&swversion=2.2&hwversion=2.0&wlanfirmware=cisco Role Required: Call Counter: Total: 0, Failed: 0	id (required) - [String] mac of the tag type (required) - [String] type of the tag name (optional) - [String] name of the tag serialnumber (optional) - [String] serial number of the tag swversion (optional) - [String] software version running in the tag hwversion (optional) - [String] hardware version of the tag wlanfirmware (optional) - [String] wlan firmware of the tag
/epe/tag/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/tag/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/tag/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 6, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/tag/_list?help=1)